{ "openapi": "3.0.0", "info": { "title": "Hyperscale Application Manager", "version": "v1.3.0", "description": "Hyperscale Application Manager API", "contact": { "name": "Delphix Support", "url": "https://support.delphix.com", "email": "support@delphix.com" } }, "servers": [ { "url": "/resources/ham/api/v1.3.0" } ], "paths": { "/api-version": { "get": { "tags": [ "ApiVersion" ], "summary": "Returns the API version of service", "operationId": "get_api_version", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "$ref": "#/components/schemas/Api-Version" } } } } } } }, "/connector-properties": { "post": { "tags": [ "ConnectorProperties" ], "summary": "To create application properties for the given connector", "operationId": "create_connector_properties", "requestBody": { "content": { "application/json": { "schema": { "x-body-name": "create_connector_properties", "$ref": "#/components/schemas/Connector-Properties" }, "examples": { "Connector-Properties": { "$ref": "#/components/examples/Connector-Properties" }, "Oracle-Properties": { "$ref": "#/components/examples/Oracle-Properties" }, "MSSQL-Properties": { "$ref": "#/components/examples/MSSQL-Properties" }, "Mongo-Properties": { "$ref": "#/components/examples/Mongo-Properties" }, "Snowflake-Properties": { "$ref": "#/components/examples/Snowflake-Properties" }, "Databricks-Properties": { "$ref": "#/components/examples/Databricks-Properties" } } } }, "description": "The parameters to create application properties for the given connector", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Connector-Properties" }, "examples": { "Connector-Properties": { "$ref": "#/components/examples/Connector-Properties" }, "Oracle-Properties": { "$ref": "#/components/examples/Oracle-Properties" }, "MSSQL-Properties": { "$ref": "#/components/examples/MSSQL-Properties" }, "Mongo-Properties": { "$ref": "#/components/examples/Mongo-Properties" }, "Snowflake-Properties": { "$ref": "#/components/examples/Snowflake-Properties" }, "Databricks-Properties": { "$ref": "#/components/examples/Databricks-Properties" } } } } }, "400": { "description": "Invalid Input provided." }, "500": { "description": "Internal Service Unavailable." } } }, "get": { "tags": [ "ConnectorProperties" ], "summary": "Returns a list of ConnectorProperties.", "operationId": "list_all_connector_properties", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Connector-Properties" } }, "examples": { "Oracle-Properties": { "$ref": "#/components/examples/Oracle-Properties" }, "MSSQL-Properties": { "$ref": "#/components/examples/MSSQL-Properties" }, "Mongo-Properties": { "$ref": "#/components/examples/Mongo-Properties" }, "Snowflake-Properties": { "$ref": "#/components/examples/Snowflake-Properties" }, "Databricks-Properties": { "$ref": "#/components/examples/Databricks-Properties" } } } } }, "500": { "description": "Internal Service Unavailable." } } } }, "/connector-properties/property-definitions": { "get": { "tags": [ "ConnectorProperties" ], "summary": "Returns a list of ConnectorProperties.", "operationId": "list_all_available_connector_property_definitions", "parameters": [ { "in": "query", "name": "connector_type", "required": false, "schema": { "type": "string", "enum": [ "ORACLE", "MSSQL", "MONGO", "SNOWFLAKE", "DATABRICKS" ] }, "description": "Returns supported connector property definitions." }, { "in": "query", "name": "property_metadata", "required": false, "schema": { "type": "boolean", "default": false }, "description": "Whether to return detailed metadata for each property." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Connector-Properties" } }, "examples": { "Oracle-Properties": { "$ref": "#/components/examples/Oracle-Properties" } } } } }, "500": { "description": "Internal Service Unavailable." } } } }, "/connector-properties/{connectorPropertiesId}": { "parameters": [ { "in": "path", "name": "connectorPropertiesId", "schema": { "type": "integer", "format": "int64", "minimum": 1 }, "required": true, "description": "Numeric ID of the ConnectorProperties." } ], "get": { "tags": [ "ConnectorProperties" ], "summary": "Returns a ConnectorProperties by ID.", "operationId": "get_by_connector_properties_id", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Connector-Properties" }, "examples": { "Connector-Properties": { "$ref": "#/components/examples/Connector-Properties" }, "Oracle-Properties": { "$ref": "#/components/examples/Oracle-Properties" } } } } }, "404": { "description": "Object Not Found." }, "500": { "description": "Internal Service Unavailable." } } }, "put": { "tags": [ "ConnectorProperties" ], "summary": "Update an existing ConnectorProperties.", "operationId": "update_connector_properties", "requestBody": { "content": { "application/json": { "schema": { "x-body-name": "update_connector_properties", "$ref": "#/components/schemas/Connector-Properties" }, "examples": { "Connector-Properties": { "$ref": "#/components/examples/Connector-Properties" }, "Oracle-Properties": { "$ref": "#/components/examples/Oracle-Properties" } } } }, "description": "The updated ConnectorProperties.", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Connector-Properties" }, "examples": { "Connector-Properties": { "$ref": "#/components/examples/Connector-Properties" }, "Oracle-Properties": { "$ref": "#/components/examples/Oracle-Properties" } } } } }, "400": { "description": "Invalid Input provided." }, "404": { "description": "Object Not Found." }, "500": { "description": "Internal Service Unavailable." } } }, "delete": { "tags": [ "ConnectorProperties" ], "summary": "Delete an existing ConnectorProperties.", "operationId": "delete_connector_properties", "responses": { "200": { "description": "OK" }, "404": { "description": "Object Not Found." }, "500": { "description": "Internal Service Unavailable." } } } }, "/instant-client": { "post": { "tags": [ "InstantClient" ], "summary": "Upload an instant client zip file.", "operationId": "upload_instant_client", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "The file to be uploaded." } }, "required": [ "file" ] } } } }, "responses": { "200": { "description": "Instant Client zip file uploaded successfully.", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Instant-Client-Upload-Response" } } } }, "400": { "description": "Invalid Input provided." }, "500": { "description": "Internal Service Unavailable." } } }, "get": { "tags": [ "InstantClient" ], "summary": "Returns the version of uploaded instant client.", "operationId": "get_instant_client_version", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Instant-Client-Upload-Response" } } } }, "404": { "description": "Object Not Found." }, "500": { "description": "Internal Service Unavailable." } } }, "delete": { "tags": [ "InstantClient" ], "summary": "Delete an existing Instant Client.", "operationId": "delete_instant_client", "responses": { "200": { "description": "OK" }, "404": { "description": "Object Not Found." }, "500": { "description": "Internal Service Unavailable." } } } }, "/hyperscale-services": { "post": { "tags": [ "HyperscaleServices" ], "summary": "Start hyperscale services for the given connectorPropertiesId", "operationId": "start_hyperscale", "requestBody": { "content": { "application/json": { "schema": { "x-body-name": "hyperscaleServicesRequest", "$ref": "#/components/schemas/Hyperscale-Services-Request" } } }, "required": true }, "responses": { "201": { "description": "Started", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Hyperscale-Services-Response" }, "examples": { "Hyperscale-Services": { "$ref": "#/components/examples/Hyperscale-Services" } } } } }, "400": { "description": "Invalid Input provided." }, "500": { "description": "Internal Service Unavailable." } } }, "put": { "tags": [ "HyperscaleServices" ], "summary": "Restart the last running hyperscale services", "operationId": "restart_hyperscale", "responses": { "201": { "description": "Restarted", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Hyperscale-Services-Response" }, "examples": { "Hyperscale-Services": { "$ref": "#/components/examples/Hyperscale-Services" } } } } }, "400": { "description": "Invalid Input provided." }, "500": { "description": "Internal Service Unavailable." } } }, "delete": { "tags": [ "HyperscaleServices" ], "summary": "Stop hyperscale services for the given connectorPropertiesId", "operationId": "stop_hyperscale", "requestBody": { "content": { "application/json": { "schema": { "x-body-name": "hyperscaleServicesRequest", "$ref": "#/components/schemas/Hyperscale-Services-Request" } } }, "required": true }, "responses": { "201": { "description": "Stopped", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Hyperscale-Services-Response" }, "examples": { "Hyperscale-Services": { "$ref": "#/components/examples/Hyperscale-Services" } } } } }, "404": { "description": "Object Not Found." }, "500": { "description": "Internal Service Unavailable." } } }, "get": { "tags": [ "HyperscaleServices" ], "summary": "Returns the latest hyperscale services details", "operationId": "get_latest_hyperscale_service", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/Hyperscale-Services-Response" } } } }, "400": { "description": "Hyperscale Services are not running" }, "404": { "description": "Object Not Found." }, "500": { "description": "Internal Service Unavailable." } } } }, "/support-bundle": { "post": { "tags": [ "SupportBundle" ], "summary": "Generates support bundle", "description": "Generates support bundle", "operationId": "generateSupportBundle", "parameters": [ { "in": "query", "name": "include_hyperscale_bundle", "required": false, "schema": { "type": "boolean", "default": true }, "description": "Whether to include hyperscale services logs in the support bundle." } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncTask" } } } }, "400": { "description": "Invalid Input provided." }, "500": { "description": "Internal Service Unavailable." } } }, "put": { "tags": [ "SupportBundle" ], "summary": "Cancel Support Bundle Generation", "operationId": "cancel_support_bundle_generation", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/AsyncTask" } } } }, "404": { "description": "Object Not Found." }, "500": { "description": "Internal Service Unavailable." } } }, "get": { "tags": [ "Downloads" ], "summary": "Downloads the support bundle generated using /support-bundle POST API.", "description": "Downloads the support bundle generated using /support-bundle POST API.", "operationId": "downloadSupportBundle", "responses": { "200": { "description": "OK", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Object Not Found.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } } } } }, "/support-bundle/status": { "get": { "tags": [ "SupportBundle" ], "summary": "Returns the status of the support bundle task.", "operationId": "get_support_bundle_status", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "$ref": "#/components/schemas/AsyncTask" } } } } } } } }, "components": { "schemas": { "Api-Version": { "title": "ApiVersion", "description": "ApiVersion model for returning the version id.", "type": "object", "properties": { "versionId": { "description": "The VersionId is used to return the current version of service.", "type": "string", "nullable": false, "minLength": 1, "maxLength": 50 } }, "required": [ "versionId" ], "example": { "versionId": "v1.2.0" } }, "Connector-Properties": { "description": "A Connector Properties.", "type": "object", "title": "ConnectorProperties", "required": [ "connector_type", "settings" ], "properties": { "id": { "type": "integer", "format": "int64", "readOnly": true }, "connector_type": { "description": "The type of the connector.", "type": "string", "enum": [ "ORACLE", "MSSQL", "MONGO", "SNOWFLAKE", "DATABRICKS" ] }, "staging_type": { "description": "Staging backend used by this connector. MOUNT uses NFS via mount.nfs; AWS_S3 uses AWS Mountpoint for S3 (mount-s3); AZURE_BLOB_STORAGE uses blobfuse2; LOCAL is for connectors that manage their own storage (e.g. Databricks). Defaults to MOUNT for backward compatibility with existing clients that omit the field.", "type": "string", "enum": [ "MOUNT", "AWS_S3", "AZURE_BLOB_STORAGE", "LOCAL" ], "default": "MOUNT" }, "properties": { "description": "Properties config for the selected connector.", "type": "object", "additionalProperties": true } } }, "Instant-Client-Upload-Response": { "title": "InstantClientUploadResponse", "type": "object", "description": "Response of Instant Client zip file-upload.", "required": [ "version" ], "properties": { "version": { "description": "Version of upload instant client zip file for further use.", "type": "string", "nullable": false, "readOnly": true } }, "example": { "version": "21.0.0.0.0" } }, "Hyperscale-Services-Request": { "title": "HyperscaleServicesRequest", "type": "object", "description": "Request object for Hyperscale Services", "required": [ "connector_properties_id" ], "properties": { "connector_properties_id": { "description": "The ID of the connector properties for which hyperscale services needs to start.", "type": "integer", "format": "int64" } }, "example": { "connector_properties_id": 1 } }, "Hyperscale-Services-Response": { "description": "Object for Hyperscale Services", "type": "object", "title": "HyperscaleServicesResponse", "required": [ "id", "status" ], "properties": { "id": { "type": "integer", "format": "int64", "readOnly": true }, "connectorPropertiesId": { "type": "integer", "format": "int64", "readOnly": true }, "apiKey": { "type": "string" }, "url": { "type": "string" }, "status": { "description": "Status of the hyperscale services.", "type": "string", "enum": [ "STARTING", "STOPPING", "RESTARTING", "RUNNING", "STOPPED", "NOT_DEPLOYED", "FAILED" ], "default": "NOT_DEPLOYED" }, "errorMessage": { "type": "string" } } }, "AsyncTask": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "readOnly": true }, "reference": { "maxLength": 100, "type": "string", "description": "The reference for the AsyncTask.", "readOnly": true }, "status": { "type": "string", "description": "The status of the AsyncTask in regard to its completion.", "readOnly": true, "enum": [ "CANCELLED", "FAILED", "RUNNING", "SUCCEEDED", "PARTIAL_SUCCEEDED" ] }, "startTime": { "type": "string", "description": "The date and time that this AsyncTask was started.", "format": "date-time", "readOnly": true }, "endTime": { "type": "string", "description": "The date and time that this AsyncTask completed.", "format": "date-time", "readOnly": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" }, "readOnly": true } }, "example": { "id": 1, "reference": "application-manager-support-20240313-13-18-04.tar.gz", "status": "SUCCEEDED", "start_time": "2024-03-13T13:18:05.366909Z", "end_time": "2024-03-13T13:19:05.955041Z" } }, "Error": { "title": "Error", "type": "object", "description": "The Error object contains information of a failure.", "properties": { "message": { "type": "string", "readOnly": true, "description": "Message providing more detail about the error that occurred, if available." }, "object_name": { "type": "string", "readOnly": true, "description": "Name of the object affected by the error." } } } }, "examples": { "Connector-Properties": { "summary": "Properties for the connector", "value": { "connector_type": "connector_type", "properties": { "key1": "value1", "key2": "value2" } } }, "Oracle-Properties": { "summary": "Properties for the Oracle connector", "value": { "connector_type": "ORACLE", "properties": { "NFS_STORAGE_HOST": "", "NFS_STORAGE_EXPORT_PATH": "", "NFS_STORAGE_MOUNT_TYPE": "", "NFS_STORAGE_MOUNT_OPTION": "" } } }, "MSSQL-Properties": { "summary": "Properties for the MSSQL connector", "value": { "connector_type": "MSSQL", "properties": { "LOAD_SPARK_BATCH_SIZE": 10000, "LOAD_CONF_DISABLE_REPLICATION": true, "NFS_STORAGE_HOST": "", "NFS_STORAGE_EXPORT_PATH": "", "NFS_STORAGE_MOUNT_TYPE": "", "NFS_STORAGE_MOUNT_OPTION": "" } } }, "Mongo-Properties": { "summary": "Properties for the Mongo connector", "value": { "connector_type": "MONGO", "properties": { "LOGGING_LEVEL_COM_DELPHIX_HYPERSCALE": "INFO", "CONCURRENT_EXPORT_LIMIT": 10, "LOAD_SERVICE_REQUIRE_POST_LOAD": false, "SKIP_UNLOAD_SPLIT_COUNT_VALIDATION": false, "SKIP_LOAD_SPLIT_COUNT_VALIDATION": false, "SOURCE_KEY_FIELD_NAMES": "database_name, collection_name", "VALIDATE_UNLOAD_ROW_COUNT_FOR_STATUS": false, "VALIDATE_MASKED_ROW_COUNT_FOR_STATUS": false, "VALIDATE_LOAD_ROW_COUNT_FOR_STATUS": false, "DISPLAY_BYTES_INFO_IN_STATUS": true, "DISPLAY_ROW_COUNT_IN_STATUS": true, "NFS_STORAGE_HOST": "", "NFS_STORAGE_EXPORT_PATH": "", "NFS_STORAGE_MOUNT_TYPE": "", "NFS_STORAGE_MOUNT_OPTION": "" } } }, "Snowflake-Properties": { "summary": "Properties for the Snowflake connector", "value": { "connector_type": "SNOWFLAKE", "staging_type": "AWS_S3", "properties": { "LOGGING_LEVEL_COM_DELPHIX_HYPERSCALE": "INFO", "CONCURRENT_EXPORT_LIMIT": 10, "SOURCE_KEY_FIELD_NAMES": "schema_name, database_name, table_name, stage_name", "DISPLAY_BYTES_INFO_IN_STATUS": true, "DISPLAY_ROW_COUNT_IN_STATUS": true, "SNOWFLAKE_TOKEN": "", "S3_BUCKET_NAME": "", "S3_REGION": "", "S3_AUTH_TYPE": "INSTANCE", "S3_PREFIX": "", "S3_DELIMITER": "/" } } }, "Databricks-Properties": { "summary": "Properties for the Databricks connector", "value": { "connector_type": "DATABRICKS", "staging_type": "LOCAL", "properties": { "LOGGING_LEVEL_COM_DELPHIX_HYPERSCALE": "INFO", "CONCURRENT_EXPORT_LIMIT": 10, "SOURCE_KEY_FIELD_NAMES": "schema_name,table_name", "DISPLAY_BYTES_INFO_IN_STATUS": true, "DISPLAY_ROW_COUNT_IN_STATUS": false, "LOAD_SERVICE_REQUIRE_POST_LOAD": false, "SKIP_UNLOAD_SPLIT_COUNT_VALIDATION": false, "SKIP_LOAD_SPLIT_COUNT_VALIDATION": false, "VALIDATE_UNLOAD_ROW_COUNT_FOR_STATUS": false, "VALIDATE_MASKED_ROW_COUNT_FOR_STATUS": false, "VALIDATE_LOAD_ROW_COUNT_FOR_STATUS": false, "MAX_CONCURRENT_LOAD_WORKERS": 0, "PLACEHOLDER_CREATE_CONCURRENCY": 8, "DATABRICKS_VALIDATION_TIMEOUT_SECONDS": 30, "RECONCILER_ENABLED": true, "DELTA_STITCH_DRIVER_MEMORY": "1g", "AZURE_BLOB_ENDPOINT_SUFFIX": "blob.core.windows.net", "SPARK_DRIVER_MEMORY_LOAD": "4g", "SPARK_DRIVER_MEMORY_UNLOAD": "1g" } } }, "Hyperscale-Services": { "summary": "Object for Hyperscale Services", "value": { "apiKey": "1.lSKSyVIoB5f3On4IetrFQa8K8eHRb14AdxbjavWhqbjHNmOKYsVt6Mu9mY3hac4k", "url": "https:///hs", "status": "RUNNING" } } } } }